home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / isprt113.zip / RTG2MDIR.DOC < prev    next >
Text File  |  1991-03-04  |  12KB  |  365 lines
  1.  
  2.                RTG2MDIR   ROUTING.BBS -> GTMDIR.BBS
  3.  
  4.                 Version 1.13
  5.  
  6. The guff at the start
  7.  
  8.    Ever get fed up with ensuring that ROUTING, and GTMDIR are kept
  9.    uptodate?... checking every week or so to see what is new, and
  10.    what echoes have closed down?... pain in the ar*e isn't it?..
  11.    Well... here's a partial solution to the problem, will build a
  12.    GTMDIR for you using the data available in your ROUTING and the
  13.    status of echoes being read in from ECHLIST.BBS, that way, you
  14.    can keep track of the temp down, retired etc echoes, as they will
  15.    be list individually on the appropriate GTMDIR.???, and also have
  16.    a combined GTMDIR.BBS available for the users, they can see which
  17.    echoes are retired etc.
  18.  
  19.  
  20. Even more junk... better read this bit though
  21. ---------------------------------------------
  22.  
  23.                 ----------------
  24.                 -> Guarantee <-
  25.                 ----------------
  26.  
  27.    You're kidding right?.... fiver says you ain't paid owt for this - so
  28.    as you lose, send me a fiver ( US$10 ) and that'll do for registration.
  29.  
  30.    The software is guaranteed to do nothing except occupy several KBytes
  31.    of disk space, and if executed, take up a little RAM, which it might
  32.    free for later use, if it terminates without hanging.
  33.  
  34.    If anything happens at all, then it isn't my fault, no responsibility
  35.    accepted for any results whatsoever which may be directly traced to
  36.    this program.
  37.  
  38.  
  39.                   ----------
  40.                   Disclaimer
  41.                   ----------
  42.  
  43.    A sign of the times I suppose, you gotta have this or someone will
  44.    try it on.
  45.  
  46.    The author accepts no responsibility for any of the results caused
  47.    by possesion of, or execution of the program distributed with this
  48.    document.
  49.  
  50.  
  51.             -----------------------------
  52.  
  53.  
  54. What's it do then?.
  55.  
  56.    Reading in GTMDIR.BBS from GTPATH directory, and ROUTING.BBS - also
  57.    from GTPATH, a series of files will be built up named GTMDIR with the
  58.    extension E00, E01 etc, contensts will be the sections of GTMDIR.BBS
  59.    containing the E01, E02 etc etc echoes.
  60.  
  61. │  All files written are placed in a sub-directory RTG2MDIR.WRK which is
  62. │  created off GTPATH.
  63.  
  64. │   The echo descriptions which are placed in the GTMDIR.??? files in the
  65. │   work directory are will be taken from the following sources:-
  66.  
  67. │    file specified on command line ( ECHOLIST format ),
  68. │        if no file specified on comamnd line, then the
  69. │        config file will be checked for a source, if none
  70. │        is given there, then ECHOLIST.BBS in your GTPATH
  71. │        will be used.
  72.  
  73. │    if none of the above files can be opened, then the descriptions
  74. │    will be taken from GTMDIR.BBS in the GTPATH.
  75.  
  76. │    if GTMDIR.BBS cannot be opened, then the echo descriptions will
  77. │    then be taken from the ROUTING.BBS.
  78.  
  79. │   This gives a multitude of source of echo descriptions. ECHOLIST is
  80. │   the best, because that allows standardisation of echo descriptions.
  81.  
  82.  
  83.  
  84. Command line Switches
  85.  
  86.    /split    this option will read in ROUTING.BBS, GTMDIR.BBS and
  87.         ECHOLIST.BBS from the GTPATH directory. A number of
  88.         files are then created, the name is GTMDIR, and the
  89.         extension will be the three letter of the echo groups
  90.         that are found in ROUTING.BBS, e.g GTMDIR.E02 etc.
  91.  
  92.         IF the pharase FIDO appears in the description of the
  93.         echo in ROUTING.BBS, then it will always be placed in
  94.         GTMDIR.DOG regardless of whether /CAT ( see below ) is
  95.         used.
  96.  
  97.         NOTE
  98.         these files will overwrite any existing files.
  99.  
  100.         These files will be in the normal GTMDIR.BBS format,
  101.         with access level, directory and description on the
  102.         one line.
  103.  
  104.         If ECHOLIST.BBS cannot be found, then the descriptions
  105.         will be extracted from the existing GTMDIR.BBS, along
  106.         with the access level to the message base.
  107.  
  108.         When GTMDIR isn't available, then the message base
  109.         description and the path are taken from those details
  110.         specified in ROUTING.BBS, and the access level to be
  111.         associated with each echo is as specified in config
  112.         file with the ACCESS parameter, if this has not been
  113. │        specified there, then it defaults to 'A'.
  114.  
  115.         Private, public, netmail, and readonly message bases
  116.         are catered for, as are those flagged as temp down,
  117.         retired, renumbered, new sponsor, unknown sponsor
  118.         etc etc in ECHOLIST.BBS ( new hours is the only one
  119.         I'm not interested ). Oh, and don't worry about any
  120.         password encrypted echoes, these should be handled
  121.         OK in the situation where the echo description is
  122.         taken from ROUTING.BBS, but don't take my word for it,
  123.         check!.
  124.  
  125.    /cat        added this because the ECHOLIST format was changed,
  126.         and a 'new' field added, a three letter category for
  127.         the echoes, e.g. SPT - Sport, CHT - chat etc etc, so
  128.         might as well let you sort our GTMDIR list by echo
  129.         subject, without you having to trail through them all.
  130.  
  131.         There may be the case where an echo is listed in the
  132.         GTMDIR and ROUTING, but has no entry in ECHOLIST, in
  133.         the UK this is rlevant to the E30 echoes. If the /CAT
  134.         switch is used, then these echoes will be listed in
  135.         GTMDIR._#_, yeah, I know it's a wierd extension, but
  136.         can *you* think of something that others might not be
  137.         using?.
  138.  
  139.  
  140.    /missing    as /SPLIT, except does not write the GTMDIR.Exx files.
  141.         just lists inconsistencies.
  142.  
  143.  
  144.    /build    builds a replacement for GTMDIR.BBS from the GTMDIR.xxx
  145.         files found in the GTPATH directory. The order in which
  146.         the files are added is the same as the order in which the
  147.         extensions are specified in the config file. Any files
  148.         whose extensions are NOT listed in the config file are
  149.         not added, but the extensions will be listed when the
  150.         build has completed.
  151.  
  152. │        Will automatically /split if no GTMDIR files are found
  153. │        in the working directory.
  154.  
  155.  
  156.    /source=d:\path\filename.ext
  157.         if specified this is the file where the descriptions
  158.         for the message bases are found. This file must be in
  159.         the same format as ECHOLIST.BBS, either the new or the
  160.         old format. If not specified on the command line, will
  161.         default to ECHOLIST.BBS in GTPATH, unless it is given
  162.         in RTG2MSIR.CFG, e.g. command line overrides whatever
  163.         is given in the config file.
  164.  
  165.         If the file specified with the /SOURCE switch can not
  166.         be opened, then the required data ( echo descriptions )
  167.         will be those found in GTMDIR.BBS.
  168.  
  169.         Note that if GTMDIR cannot be opened, then the echo
  170.         descriptions will be those you have given in your
  171.         ROUTING.BBS
  172.  
  173.  
  174. │  /welcome[=d:\path\filename.ext]
  175. │        creates a WELCOME.BBS in each message area. The text it
  176. │        taken from the appropriate section of FILENAME.EXT. If
  177. │        no file is specified, the ECHODESC.BBS in GTPATH will
  178. │        be used.
  179. │
  180. │        The format of this is simple.
  181. │
  182. │        Exx/yyy
  183. │
  184. │        details of the echo
  185. │
  186. │        Exy/yyz         ( next echo number )
  187. │
  188. │        for Exx/yyy all text between Exx and Exx/yyz will be
  189. │        put in WELCOME.BSS
  190. │
  191. │        The echo numbers must be in column one with no other
  192. │        text on the line. Other than that the text is lifted
  193. │        verbatim.
  194. │
  195. │        This option isn't particularly fast, but will do the
  196. │        job, and afer all, it's not often that you would have
  197. │        to do this anyway.
  198. │
  199. │        ECHODESC.BBS is a perfect source for these details.
  200. │        In fact it's existence led me to doing this bit.
  201.  
  202.  
  203. │  /new        when used with /WELCOME
  204. │        this will write only new WELCOME.BBS files, and will
  205. │               not overwrite any pre-exisitng WELCOME.BBS that you
  206. │        may have already seat up.
  207.  
  208.  
  209. │        when used with /SPLIT
  210. │        will check the specified directory for each of the
  211. │        entries in ROUTING.BBS, and offer the option for you
  212. │        to create the directory.
  213. │        Also applies to /BUILD when RTG2MDR.WRK is empty and
  214. │        /BUILD does a split.
  215.  
  216. │        When a directory has been determined as missing, you
  217. │        will be prompted to create it, skip over this one,
  218. │        create this and all further missing directories, and
  219. │        finally you can ignore this one, and all further ones.
  220.  
  221.  
  222.    /old[nn]    checks MAILIN to determine last bag delivered for each
  223.         echo and copies entries in GTMDIR.BBS which are older
  224.         than nn days to GTMDIR.OLD
  225.  
  226.         NOTE if no qbags are found, it will be assumed that
  227.         this is a new echo.
  228.  
  229.         /* NOT YET AVAILABLE */
  230.  
  231.  
  232.    Config file
  233.  
  234.    The config file - which must be located in the GTPATH directory -
  235.    RTG2MDIR.CFG has the following structure
  236.  
  237.            DEFAULT=d:\path\name.ext
  238.            MAILDRIVE=d:
  239.            EXTENSIONS    this MUST be on first column
  240.            NET
  241.            LOC
  242.            E00
  243.            E01
  244.            E02
  245.            E03
  246.            E05
  247.            E06
  248.            E10
  249.            E30    This comment appears in composite GTMDIR
  250.            END
  251.            ACCESS = A
  252.  
  253.     the extensions are in the order in which the GTMDIR.ext files
  254.     are to be concatenated. If the extension is not found in this
  255.     file, then it will not be included in the concatenated file
  256.     created with the /build switch.
  257.  
  258.     This file is fairly free format, any text after the data is
  259. │    disregarded and can be used as comments. Text following the
  260. │    extensions in either the CATEGORIES or EXTENSIONS sections
  261. │    will appear before the first message base in the composite
  262. │    file. This allows you to add a little one liner comment at
  263. │    the start of each section, this gives the users another way
  264. │    of seeing what the echo subjects are.
  265. │
  266. │    Refer to the sample RTG2MDR.CFG enclosed in the ZIP.
  267.  
  268.     If the /CAT switch has been used, I'd suggest that you enter
  269.     all the categories listed in ECHOLIST.BBS in RTG2MDIR.CFG
  270.     under the CATEGORIES section.
  271.  
  272.     There is a special file created for those message areas that
  273.     are 'funny', i.e. may not be in the echolist or whatever. The
  274. │    extension on this file is ".#_#".
  275.  
  276.  
  277. Support
  278.  
  279.    You can either netmail me on 013/300, or subscribe to
  280.  
  281.     E03/607  UK Utilities Support
  282.  
  283.    available from a hub near you now....
  284.  
  285.  
  286. Timings
  287.  
  288.    Running on an IBM PS/2 model 50, 10MHz with co-pro, this program
  289.    takes 1m21s to /SPLIT apart a routing file with 382 echoes listed.
  290.    ECHOLIST.BBS was available to supply the echo descriptions.
  291.  
  292.    /WELCOME switch run on same PC, 43 secs, to write WELCOME.BBS for
  293.    128 echoes, including creating directories, with 60 echoes
  294.    having no description found.
  295.  
  296.    /BUILD took 1m43s, creating GTMDIR with 241 echoes listed.
  297.  
  298.  
  299. Restrictions
  300.  
  301.    Only 400 echoes currently supported, this includes those listed
  302.    in ECHOLIST.BBS, so if ECHOLIST.BBS gets any larger......
  303.  
  304.    Path to message base no more then 30 chars and must include the
  305.    drive letter.
  306.  
  307.    Echo description no more then 60 characters, the description in
  308.    ECHOLIST.BBS is less than this.
  309.  
  310.    Will run with down to 180K of RAM free.
  311.  
  312.  
  313. Finally
  314.  
  315.    What the h*ll, give it a bash, it might just save you some hassle.
  316.    Oh, where to send that fiver?.... easy...
  317.  
  318.    Dùn Eideann Dungeon 013/300
  319.    71 Burnside Terrace
  320.    POLBETH
  321.    West Lothian
  322.    EH55 8SU
  323.    SCOTLAND
  324.  
  325.    cash is fine, but cheques accepted....
  326.  
  327.  
  328. Revision History
  329.  
  330. V1.00    19/02/91    initial release
  331.  
  332. v1.10    20/02/91    8 hrs later Perry changed the format of the
  333.             ECHOLIST.BBS file. Thanks Perry.... <grin>
  334.             Gave an excuse to add the /CAT switch.
  335.             This version will work with both formats of
  336.             ECHOLIST.BBS
  337.  
  338. 1.11    21/02/91    source rationalisation - not released.
  339.  
  340. 1.12    22/02/91    now takes comments following extension in
  341.             RTG2MDIR.CFG and places them in the composite
  342.             routing file at the start of each section.
  343.  
  344.             fixed small bug with Netmail/Private/Public
  345.             message bases.
  346.  
  347.             added /WELCOME and /NEW, to place WELCOME.BBS
  348.             in the message directories.
  349.  
  350. 1.13    23/02/91    /WELCOME is a tiny bit faster now. Was taking
  351.             several minutes ( 18m on my PC ), now down to
  352.             about 15s.
  353.  
  354.             /NEW will check for message directories when
  355.             used with /SPLIT, and prompt user to create
  356.             it.
  357.  
  358.  
  359. Credits(?).
  360.  
  361. You, for giving this thing a try.
  362.  
  363. Scott Estes,     The Sprawl   032/004 for ECHODESC ( GTEDxxyy.ZIP )
  364. Perry Alexander, Infostation, 032/001 for ECHOLIST ( GTELxxyy.ZIP )
  365.